D:\a\cssh-rs\cssh-rs\cssh-rs-protocol\src\v1\capability.rs
Line | Count | Source |
1 | | //! Protocol version compatibility and capability negotiation. |
2 | | |
3 | | use std::collections::BTreeSet; |
4 | | |
5 | | use crate::v1::version::ProtocolVersion; |
6 | | |
7 | | /// Error returned when two peers' protocol major versions differ. |
8 | | #[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)] |
9 | | #[error("incompatible protocol major version: local {local}, remote {remote}")] |
10 | | pub struct VersionMismatch { |
11 | | /// This endpoint's protocol version. |
12 | | pub local: ProtocolVersion, |
13 | | /// The peer's protocol version. |
14 | | pub remote: ProtocolVersion, |
15 | | } |
16 | | |
17 | | /// Accept the peer when the protocol major versions match. |
18 | | /// |
19 | | /// # Arguments |
20 | | /// * `local` - This endpoint's protocol version. |
21 | | /// * `remote` - The peer's advertised protocol version. |
22 | | /// |
23 | | /// # Returns |
24 | | /// `Ok(())` when the major versions match; a differing minor is compatible. |
25 | | /// |
26 | | /// # Errors |
27 | | /// Returns [`VersionMismatch`] when the major versions differ. |
28 | 8 | pub fn check_version( |
29 | 8 | local: ProtocolVersion, |
30 | 8 | remote: ProtocolVersion, |
31 | 8 | ) -> Result<(), VersionMismatch> { |
32 | 8 | if local.major == remote.major { |
33 | 7 | return Ok(()); |
34 | 1 | } |
35 | 1 | return Err(VersionMismatch { local, remote }); |
36 | 8 | } |
37 | | |
38 | | /// Return the capabilities both peers advertise. |
39 | | /// |
40 | | /// # Arguments |
41 | | /// * `local` - Capability flags this endpoint advertises. |
42 | | /// * `remote` - Capability flags the peer advertises. |
43 | | /// |
44 | | /// # Returns |
45 | | /// The intersection of the two flag sets, deduplicated and sorted ascending |
46 | | /// so the result is deterministic regardless of input order. |
47 | 3 | pub fn negotiate_capabilities(local: &[String], remote: &[String]) -> Vec<String> { |
48 | 5 | let remote_set3 : BTreeSet<&str>3 = remote3 .iter3 ().map3 (|flag| return flag.as_str()).collect3 (); |
49 | 3 | let mut shared: Vec<String> = Vec::new(); |
50 | 6 | for capability in local3 { |
51 | 6 | if remote_set.contains(capability.as_str()) { |
52 | 4 | shared.push(capability.clone()); |
53 | 4 | }2 |
54 | | } |
55 | 3 | shared.sort(); |
56 | 3 | shared.dedup(); |
57 | 3 | return shared; |
58 | 3 | } |
59 | | |
60 | | /// Return the maximum frame size two peers agree on. |
61 | | /// |
62 | | /// # Arguments |
63 | | /// * `local` - This endpoint's advertised maximum receivable frame size. |
64 | | /// * `remote` - The peer's advertised maximum receivable frame size. |
65 | | /// |
66 | | /// # Returns |
67 | | /// The smaller of the two - the send limit both sides honor. |
68 | 10 | pub fn negotiate_max_frame_len(local: u32, remote: u32) -> u32 { |
69 | 10 | return local.min(remote); |
70 | 10 | } |
71 | | |
72 | | #[cfg(test)] |
73 | | #[path = "../tests/v1/test_capability.rs"] |
74 | | mod tests; |